home *** CD-ROM | disk | FTP | other *** search
/ Ultra Pack / UltraComputing Partner Applications.iso / SunLabs / tclTK / src / tcl7.4 / tests / README < prev    next >
Encoding:
Text File  |  1994-10-13  |  3.6 KB  |  96 lines
  1. Tcl Test Suite
  2. --------------
  3.  
  4. @(#) README 1.1 94/08/09 12:59:51
  5.  
  6. This directory contains a set of validation tests for the Tcl
  7. commands.  Each of the files whose name ends in ".test" is
  8. intended to fully exercise one or a few Tcl commands.  The
  9. commands tested by a given file are listed in the first line
  10. of the file.
  11.  
  12. You can run the tests in two ways:
  13.     (a) type "make test" in the parent directory to this one; this
  14.         will run all of the tests.
  15.     (b) start up tcltest in this directory, then "source" the test
  16.         file (for example, type "source parse.test").  To run all
  17.     of the tests, type "source all".
  18. In either case no output will be generated if all goes well, except
  19. for a listing of the tests..  If there are errors then additional
  20. messages will appear in the format described below.
  21.  
  22. The rest of this file provides additional information on the
  23. features of the testing environment.
  24.  
  25. This approach to testing was designed and initially implemented
  26. by Mary Ann May-Pumphrey of Sun Microsystems.  Many thanks to
  27. her for donating her work back to the public Tcl release.
  28.  
  29. Definitions file:
  30. -----------------
  31.  
  32. The file "defs" defines a collection of procedures and variables
  33. used to run the tests.  It is read in automatically by each of the
  34. .test files if needed, but once it has been read once it will not
  35. be read again by the .test files.  If you change defs while running
  36. tests you'll have to "source" it by hand to load its new contents.
  37.  
  38. Test output:
  39. ------------
  40.  
  41. Normally, output only appears when there are errors.  However, if
  42. the variable VERBOSE is set to 1 then tests will be run in "verbose"
  43. mode and output will be generated for each test regardless of
  44. whether it succeeded or failed.  Test output consists of the
  45. following information:
  46.  
  47.     - the test identifier (which can be used to locate the test code
  48.         in the .test file)
  49.     - a brief description of the test
  50.     - the contents of the test code
  51.     - the actual results produced by the tests
  52.     - a "PASSED" or "FAILED" message
  53.     - the expected results (if the test failed)
  54.  
  55. You can set VERBOSE either interactively (after the defs file has been
  56. read in), or you can change the default value in "defs".
  57.  
  58. Selecting tests for execution:
  59. ------------------------------
  60.  
  61. Normally, all the tests in a file are run whenever the file is
  62. "source"d.  However, you can select a specific set of tests using
  63. the global variable TESTS.  This variable contains a pattern;  any
  64. test whose identifier matches TESTS will be run.  For example,
  65. the following interactive command causes all of the "for" tests in
  66. groups 2 and 4 to be executed:
  67.  
  68.     set TESTS {for-[24]*}
  69.  
  70. TESTS defaults to *, but you can change the default in "defs" if
  71. you wish.
  72.  
  73. Saving keystrokes:
  74. ------------------
  75.  
  76. A convenience procedure named "dotests" is included in file
  77. "defs".  It takes two arguments--the name of the test file (such
  78. as "parse.test"), and a pattern selecting the tests you want to
  79. execute.  It sets TESTS to the second argument, calls "source" on
  80. the file specified in the first argument, and restores TESTS to
  81. its pre-call value at the end.
  82.  
  83. Batch vs. interactive execution:
  84. --------------------------------
  85.  
  86. The tests can be run in either batch or interactive mode.  Batch
  87. mode refers to using I/O redirection from a UNIX shell.  For example,
  88. the following command causes the tests in the file named "parse.test"
  89. to be executed:
  90.  
  91.     tclTest < parse.test > parse.test.results
  92.  
  93. Users who want to execute the tests in this fashion need to first
  94. ensure that the file "defs" has proper values for the global
  95. variables that control the testing environment (VERBOSE and TESTS).
  96.